New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) #24173

TalShafir · 2017-05-01T18:17:05Z

SUMMARY

New module that lets the user run Tempest

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

os_tempest_run

ANSIBLE VERSION

ansible 2.4.0 (module/os_tempest_run c7c81835cb) last updated 2017/05/01 21:11:35 (GMT +300)
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/tshafir/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/tshafir/ansible/lib/ansible
  executable location = /home/tshafir/ansible/bin/ansible
  python version = 2.7.5 (default, Aug 18 2016, 15:58:25) [GCC 4.8.5 20150623 (Red Hat 4.8.5-4)]

ansibot · 2017-05-01T18:28:19Z

The test ansible-test sanity --test pep8 failed with the following errors:

lib/ansible/modules/cloud/openstack/os_tempest_run.py:28:78: W291 trailing whitespace
lib/ansible/modules/cloud/openstack/os_tempest_run.py:79:145: W291 trailing whitespace
lib/ansible/modules/cloud/openstack/os_tempest_run.py:236:1: W293 blank line contains whitespace

click here for bot help

TalShafir · 2017-05-01T18:34:39Z

The bot didn't tag anyone again.
@emonty @Shrews @juliakreger @j2sol @rcarrillocruz @Thingee

ready_for_review

gundalow · 2017-05-03T12:04:37Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+options:
+    workspace:
+        description:
+            The workspace as was configured in 'Tempest init <I(workspace)>'


The I(workspace) will turn into italics, which I'm not sure if that's what you want in this case

https://docs.ansible.com/ansible/dev_guide/developing_modules_documenting.html#formatting-options

The documentation says "I() for option names" but I think I'll change that to C(workspace) to make it more visible.
edit: now that I think about it, it should be C(workspace) as it is the option value and not the name.

gundalow · 2017-05-03T12:06:26Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+notes:
+    - You can find out more about Tempest at U(http://docs.openstack.org/developer/tempest/)
+    - The module requires to tempest init <I(workspace)> before usage
+    - The options I(whitelist_file) and I(blacklist_file) are mutually exclusive, if they are both given only the I(whitelist_file) will be used


If you use the mutually_exclusive function you can remove this line

gundalow · 2017-05-03T12:38:27Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+'''
+
+EXAMPLES = '''
+# Run all tests with default number of workers


As per Ansible best practice, please use - name: Run all tests with default number of workers then remove the - from in front of the module name

http://docs.ansible.com/ansible/dev_guide/developing_modules_documenting.html#examples-block

Thanks, I fixed it.
I originally wrote it after looking at the pip module as an example (https://docs.ansible.com/ansible/pip_module.html#examples), might be nice to add it as an issue for something like 'First Timers Only' or 'YourFirstPR'.

That's a good idea.

Where in the existing documentation/examples did you look?

I'm wondering where I can put/link to the example so people will find it.

In the documentation website: https://docs.ansible.com/ansible/pip_module.html#examples
And in the module implementation starts at: https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/packaging/language/pip.py#L148

gundalow · 2017-05-03T12:40:38Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+        concurrency=dict(type="int", required=False, default=None),
+        force=dict(type="bool", required=False, default=False),
+        subunit=dict(type="bool", required=False, default=True),
+    ))


There are some options to AnsibleModule which you may be able to use to validate options passed in.
Look at existing modules for examples:

mutually_exclusive required_together required_one_of require_if

Should whitelist_file and blacklist_file be mutually_exclusive
mutually_exclusive=(('blacklist_file', 'whitelist_file'),),

gundalow · 2017-05-03T12:43:56Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+DOCUMENTATION = '''
+---
+module: os_tempest_run
+short_description: Runs Tempest


I wonder if it might be worth saying Run OpenStack Tempest to make it a little easier for people to find via a search engine.

gundalow · 2017-05-03T12:45:09Z

lib/ansible/modules/cloud/openstack/os_tempest_run.py

+    :arg follow: A boolean to indicate of symlinks should be resolved or not
+    :raises UnicodeDecodeError: If the canonicalized version of the path
+        contains non-utf8 byte sequences.
+    :rtype: A text string (unicode on pyyhon2, str on python3).


pyyhon2 -> python2

…ot the name

TalShafir · 2017-05-03T13:51:13Z

Thanks for the review @gundalow
ready_for_review

ansibot · 2017-05-03T14:10:10Z

waiting_on: TalShafir
module: os_tempest_run
changes_requested_by: gundalow
needs_info: False
needs_revision: True
needs_rebase: False
merge_commits: []
mergeable_state: clean
shippable_status: success
maintainer_shipits: 0
community_shipits: 0
ansible_shipits: 0
shipit_actors: []

click here for bot help

TalShafir · 2017-05-03T14:11:32Z

ready_for_review

Shrews · 2017-05-24T14:33:30Z

Hi! Thanks for the new module. However, I don't feel like tempest modules are a good fit here. The current set of modules are geared toward using OpenStack services. Modules for testing the services seems like they should be kept separate. Most consumers of the core Ansible OpenStack cloud modules are only going to be interested in the former, not the latter.

And on a more personal level, as a core maintainer for these modules, I don't want to have to learn the tempest testing environment in order to support these going forward. I just have no interest in it.

I'd like to get more feedback from possibly @emonty, @j2sol, or @rcarrillocruz and get their thoughts on this.

omgjlk · 2017-05-24T22:58:10Z

I agree with @Shrews

ansibot · 2017-06-27T04:19:01Z

@j2sol @juliakreger @Shrews @Thingee

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

ansibot · 2017-09-01T16:52:51Z

cc @dagnello
click here for bot help

ansibot · 2018-10-13T04:52:06Z

cc @mnaser
click here for bot help

mnaser · 2018-10-13T11:54:03Z

I agree with @omgjlk and @Shrews. I would recommend the following role to run Tempest if you'd like

https://github.com/openstack/openstack-ansible-os_tempest

@emonty do you feel the same as well?

ansibot · 2018-11-02T02:01:45Z

cc @cloudnull @evrardjp @odyssey4me
click here for bot help

ansibot · 2019-04-06T23:53:25Z

cc @gtema
click here for bot help

sshnaidm · 2020-01-20T13:53:46Z

Thanks for submitting patch for Openstack Ansible modules!
We moved Openstack Ansible modules to Openstack repositories.
Next patches should be submitted not with Ansible Github but with
Openstack Gerrit: https://review.opendev.org/#/q/project:openstack/ansible-collections-openstack
Please submit your code there from now.
Thanks for your contribution and sorry for inconvienience.

Akasurde · 2020-08-19T08:51:08Z

Closing as per above.

added os_tempest_run module

c7c8183

fixed pep8 errors

0381054

ansibot added community_review In order to be merged, this PR must follow the community review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels May 1, 2017

gundalow requested changes May 3, 2017

View reviewed changes

gundalow removed the needs_triage Needs a first human triage before being processed. label May 3, 2017

ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels May 3, 2017

TalShafir added 2 commits May 3, 2017 16:24

documentation fix and use AnsibleModule's mutually_exclusive

bca8093

change from I(workspace) to C(workspace) as the value is needed and n…

cb77586

…ot the name

fixed author format in the documentation

ed4e743

gundalow approved these changes May 3, 2017

View reviewed changes

gundalow requested review from emonty, Shrews and rcarrillocruz May 3, 2017 14:14

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label May 15, 2017

alikins changed the title ~~New Module: os_tempest_run module~~ New module: Add Cloudstack Tempest run module (cloud/openstack/os_tempest_run) May 22, 2017

alikins changed the title ~~New module: Add Cloudstack Tempest run module (cloud/openstack/os_tempest_run)~~ New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) May 22, 2017

ansibot added the support:community This issue/PR relates to code supported by the Ansible community. label Jun 29, 2017

ansibot added the new_contributor This PR is the first contribution by a new community member. label Oct 18, 2017

ansibot removed the new_contributor This PR is the first contribution by a new community member. label Nov 3, 2017

ansibot added the new_contributor This PR is the first contribution by a new community member. label Jan 22, 2018

ansibot added collection Related to Ansible Collections work collection:openstack.cloud needs_collection_redirect https://github.com/ansible/ansibullbot/blob/master/docs/collection_migration.md labels Apr 29, 2020

ansibot added the collection:sshnaidm.cloud label May 17, 2020

ansibot removed the collection:sshnaidm.cloud label Jun 3, 2020

Akasurde closed this Aug 19, 2020

ansible locked and limited conversation to collaborators Sep 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) #24173

New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) #24173

TalShafir commented May 1, 2017

ansibot commented May 1, 2017

TalShafir commented May 1, 2017 •

edited

gundalow May 3, 2017

TalShafir May 3, 2017 •

edited

gundalow May 3, 2017

gundalow May 3, 2017

TalShafir May 3, 2017 •

edited

gundalow May 3, 2017

TalShafir May 3, 2017 •

edited

gundalow May 3, 2017

gundalow May 3, 2017

gundalow May 3, 2017

TalShafir commented May 3, 2017

ansibot commented May 3, 2017

TalShafir commented May 3, 2017

Shrews commented May 24, 2017

omgjlk commented May 24, 2017

ansibot commented Jun 27, 2017

ansibot commented Sep 1, 2017

ansibot commented Oct 13, 2018

mnaser commented Oct 13, 2018

ansibot commented Nov 2, 2018

ansibot commented Apr 6, 2019

sshnaidm commented Jan 20, 2020

Akasurde commented Aug 19, 2020

New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) #24173

New module: Add Openstack Tempest run module (cloud/openstack/os_tempest_run) #24173

Conversation

TalShafir commented May 1, 2017

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

ansibot commented May 1, 2017

TalShafir commented May 1, 2017 • edited

gundalow May 3, 2017

Choose a reason for hiding this comment

TalShafir May 3, 2017 • edited

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

TalShafir May 3, 2017 • edited

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

TalShafir May 3, 2017 • edited

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

gundalow May 3, 2017

Choose a reason for hiding this comment

TalShafir commented May 3, 2017

ansibot commented May 3, 2017

TalShafir commented May 3, 2017

Shrews commented May 24, 2017

omgjlk commented May 24, 2017

ansibot commented Jun 27, 2017

ansibot commented Sep 1, 2017

ansibot commented Oct 13, 2018

mnaser commented Oct 13, 2018

ansibot commented Nov 2, 2018

ansibot commented Apr 6, 2019

sshnaidm commented Jan 20, 2020

Akasurde commented Aug 19, 2020

TalShafir commented May 1, 2017 •

edited

TalShafir May 3, 2017 •

edited

TalShafir May 3, 2017 •

edited

TalShafir May 3, 2017 •

edited